<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: OVD</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__syspm__functions__ovd.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">OVD<div class="ingroups"><a class="el" href="group__group__syspm.html">SysPm        (System Power Management)</a> &raquo; <a class="el" href="group__group__syspm__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga281eb6cda7b0af2aa5660d3e53df0381"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ovd.html#ga281eb6cda7b0af2aa5660d3e53df0381">Cy_SysPm_OvdEnable</a> (<a class="el" href="group__group__syspm__data__enumerates.html#ga1d2ca460c2f87303cc154d08b2fb7a21">cy_en_syspm_ovd_sel_t</a> ovdSel)</td></tr>
<tr class="memdesc:ga281eb6cda7b0af2aa5660d3e53df0381"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables OVD over either VDDD or VDDA or VCCD.  <a href="#ga281eb6cda7b0af2aa5660d3e53df0381">More...</a><br /></td></tr>
<tr class="separator:ga281eb6cda7b0af2aa5660d3e53df0381"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga183f41d01c8e34e7217d3e8a2321a1d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ovd.html#ga183f41d01c8e34e7217d3e8a2321a1d1">Cy_SysPm_OvdDisable</a> (<a class="el" href="group__group__syspm__data__enumerates.html#ga1d2ca460c2f87303cc154d08b2fb7a21">cy_en_syspm_ovd_sel_t</a> ovdSel)</td></tr>
<tr class="memdesc:ga183f41d01c8e34e7217d3e8a2321a1d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables OVD over either VDDD or VDDA or VCCD.  <a href="#ga183f41d01c8e34e7217d3e8a2321a1d1">More...</a><br /></td></tr>
<tr class="separator:ga183f41d01c8e34e7217d3e8a2321a1d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga898103e00c1e46dfe5e586d6b8661ca0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ovd.html#ga898103e00c1e46dfe5e586d6b8661ca0">Cy_SysPm_OvdVdddSelect</a> (<a class="el" href="group__group__syspm__data__enumerates.html#ga171f49b013986cf02925d88a945a3dde">cy_en_syspm_ovd_vddd_sel_t</a> ovdVdddSel)</td></tr>
<tr class="memdesc:ga898103e00c1e46dfe5e586d6b8661ca0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects voltage threshold for OVD on VDDD.  <a href="#ga898103e00c1e46dfe5e586d6b8661ca0">More...</a><br /></td></tr>
<tr class="separator:ga898103e00c1e46dfe5e586d6b8661ca0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga813fa0e79732aa2799e30f5f6fd4e199"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ovd.html#ga813fa0e79732aa2799e30f5f6fd4e199">Cy_SysPm_OvdVddaSelect</a> (<a class="el" href="group__group__syspm__data__enumerates.html#ga826b5c441042deb86518565c0139a540">cy_en_syspm_ovd_vdda_sel_t</a> ovdVddaSel)</td></tr>
<tr class="memdesc:ga813fa0e79732aa2799e30f5f6fd4e199"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects voltage threshold for OVD on VDDA.  <a href="#ga813fa0e79732aa2799e30f5f6fd4e199">More...</a><br /></td></tr>
<tr class="separator:ga813fa0e79732aa2799e30f5f6fd4e199"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4e21d09c38fcf794d76936397bd46da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ovd.html#gae4e21d09c38fcf794d76936397bd46da">Cy_SysPm_OvdActionSelect</a> (<a class="el" href="group__group__syspm__data__enumerates.html#ga13164732f4686b9400eb2641d4594de7">cy_en_syspm_ovd_action_select_t</a> ovdActionSelect)</td></tr>
<tr class="memdesc:gae4e21d09c38fcf794d76936397bd46da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the action taken when the threshold is crossed in the programmed directions(s) for VDDA.  <a href="#gae4e21d09c38fcf794d76936397bd46da">More...</a><br /></td></tr>
<tr class="separator:gae4e21d09c38fcf794d76936397bd46da"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga281eb6cda7b0af2aa5660d3e53df0381"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga281eb6cda7b0af2aa5660d3e53df0381">&#9670;&nbsp;</a></span>Cy_SysPm_OvdEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_OvdEnable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#ga1d2ca460c2f87303cc154d08b2fb7a21">cy_en_syspm_ovd_sel_t</a>&#160;</td>
          <td class="paramname"><em>ovdSel</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables OVD over either VDDD or VDDA or VCCD. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ovdSel</td><td><a class="el" href="group__group__syspm__data__enumerates.html#ga1d2ca460c2f87303cc154d08b2fb7a21">cy_en_syspm_ovd_sel_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1C devices.</dd>
<dd>
OVD over VDDD and VCCD are enabled by default and cannot be disabled. </dd></dl>

</div>
</div>
<a id="ga183f41d01c8e34e7217d3e8a2321a1d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga183f41d01c8e34e7217d3e8a2321a1d1">&#9670;&nbsp;</a></span>Cy_SysPm_OvdDisable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_OvdDisable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#ga1d2ca460c2f87303cc154d08b2fb7a21">cy_en_syspm_ovd_sel_t</a>&#160;</td>
          <td class="paramname"><em>ovdSel</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables OVD over either VDDD or VDDA or VCCD. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ovdSel</td><td><a class="el" href="group__group__syspm__data__enumerates.html#ga1d2ca460c2f87303cc154d08b2fb7a21">cy_en_syspm_ovd_sel_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1C devices.</dd>
<dd>
OVD over VDDD and VCCD are enabled by default and cannot be disabled.</dd>
<dd>
Disabling OVD over VDDA will perform the /ref cy_en_syspm_ovd_action_select_t action selected for VDDA. If no action is desired when disabling, firmware must first write CY_SYSPM_OVD_ACTION_NOTHING in a separate write cycle. </dd></dl>

</div>
</div>
<a id="ga898103e00c1e46dfe5e586d6b8661ca0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga898103e00c1e46dfe5e586d6b8661ca0">&#9670;&nbsp;</a></span>Cy_SysPm_OvdVdddSelect()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_OvdVdddSelect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#ga171f49b013986cf02925d88a945a3dde">cy_en_syspm_ovd_vddd_sel_t</a>&#160;</td>
          <td class="paramname"><em>ovdVdddSel</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Selects voltage threshold for OVD on VDDD. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ovdVdddSel</td><td><a class="el" href="group__group__syspm__data__enumerates.html#ga171f49b013986cf02925d88a945a3dde">cy_en_syspm_ovd_vddd_sel_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1C devices. </dd></dl>

</div>
</div>
<a id="ga813fa0e79732aa2799e30f5f6fd4e199"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga813fa0e79732aa2799e30f5f6fd4e199">&#9670;&nbsp;</a></span>Cy_SysPm_OvdVddaSelect()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_OvdVddaSelect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#ga826b5c441042deb86518565c0139a540">cy_en_syspm_ovd_vdda_sel_t</a>&#160;</td>
          <td class="paramname"><em>ovdVddaSel</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Selects voltage threshold for OVD on VDDA. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ovdVddaSel</td><td><a class="el" href="group__group__syspm__data__enumerates.html#ga826b5c441042deb86518565c0139a540">cy_en_syspm_ovd_vdda_sel_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1C devices. </dd></dl>

</div>
</div>
<a id="gae4e21d09c38fcf794d76936397bd46da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae4e21d09c38fcf794d76936397bd46da">&#9670;&nbsp;</a></span>Cy_SysPm_OvdActionSelect()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_OvdActionSelect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#ga13164732f4686b9400eb2641d4594de7">cy_en_syspm_ovd_action_select_t</a>&#160;</td>
          <td class="paramname"><em>ovdActionSelect</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the action taken when the threshold is crossed in the programmed directions(s) for VDDA. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ovdActionSelect</td><td><a class="el" href="group__group__syspm__data__enumerates.html#ga13164732f4686b9400eb2641d4594de7">cy_en_syspm_ovd_action_select_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1C devices.</dd>
<dd>
This API is not applicable for selectng actions for VDDD and VCCD as the default action is RESET for them. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
